@karinjs/adapter-qqbot 1.0.1

package/README.md

@@ -0,0 +1,80 @@
+# qaq
+
+开发中...
+
+如需使用:
+  在`config\plugin\@karinjs\adapter-qqbot`创建`config.yaml`
+  输入以下内容，请自行配置账号。当前`Markdown`仅支持`旧图文模板`和`原生`
+
+  ```yaml
+  # 全局默认配置 以下所有配置均可在账号配置中单独配置
+default:
+  # 获取调用凭证的api
+  accessTokenApi: https://bots.qq.com/app/getAppAccessToken
+  # 沙盒api
+  sandBoxApi: https://sandbox.api.sgroup.qq.com
+  # 正式环境api
+  qqBotApi: https://api.sgroup.qq.com
+  # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
+  sendMode: 0
+  # 是否开启沙盒环境
+  sandBox: false
+  # 是否启用频道机器人 未适配
+  guild: false
+  # 频道机器人模式 0-公域机器人 1-私域机器人
+  guildMode: 0
+
+  # 机器人Markdown模板ID 只有在sendMode为3或4时有效
+  templateId: ""
+
+  # 机器人旧图文模板Markdown配置
+  oldTemplate:
+    # 开头文字
+    textStartKey: text_start
+    # 图片描述
+    imgDescKey: img_dec
+    # 图片地址
+    imgUrlKey: img_url
+    # 结尾文字
+    textEndKey: text_end
+
+  # 机器人纯文模板Markdown配置
+  textTemplate:
+    - text_0
+    - text_1
+    - text_2
+    - text_3
+    - text_4
+    - text_5
+    - text_6
+    - text_7
+    - text_8
+    - text_9
+
+  # 文本中的url转二维码白名单 配置后将不转换这些url为二维码
+  exclude: []
+  # 接受到消息后对文本进行表达式处理
+  regex: [
+      {
+        # 表达式
+        reg: "^#",
+        # 替换为
+        rep: "",
+      },
+    ]
+
+# 账号配置列表
+accounts:
+  default:
+    # 机器人ID 必须为字符串
+    appId: "123456789"
+    # 机器人密钥
+    secret: "123456789"
+    # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
+    sendMode: 0
+    # 文本中的url转二维码白名单 配置后将不转换这些url为二维码 优先级高于全局配置
+    exclude: []
+    # 接受到消息后对文本进行表达式处理 优先级高于全局配置
+    regex: []
+
+  ```

package/config/config.yaml

@@ -0,0 +1,69 @@
+# 全局默认配置 以下所有配置均可在账号配置中单独配置
+default:
+  # 获取调用凭证的api
+  accessTokenApi: https://bots.qq.com/app/getAppAccessToken
+  # 沙盒api
+  sandBoxApi: https://sandbox.api.sgroup.qq.com
+  # 正式环境api
+  qqBotApi: https://api.sgroup.qq.com
+  # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
+  sendMode: 0
+  # 是否开启沙盒环境
+  sandBox: false
+  # 是否启用频道机器人
+  guild: false
+  # 频道机器人模式 0-公域机器人 1-私域机器人
+  guildMode: 0
+
+  # 机器人Markdown模板ID 只有在sendMode为3或4时有效
+  templateId: ""
+
+  # 机器人旧图文模板Markdown配置
+  oldTemplate:
+    # 开头文字
+    textStartKey: text_start
+    # 图片描述
+    imgDescKey: img_dec
+    # 图片地址
+    imgUrlKey: img_url
+    # 结尾文字
+    textEndKey: text_end
+
+  # 机器人纯文模板Markdown配置
+  textTemplate:
+    - text_0
+    - text_1
+    - text_2
+    - text_3
+    - text_4
+    - text_5
+    - text_6
+    - text_7
+    - text_8
+    - text_9
+
+  # 文本中的url转二维码白名单 配置后将不转换这些url为二维码
+  exclude: []
+  # 接受到消息后对文本进行表达式处理
+  regex: [
+      {
+        # 表达式
+        reg: "^#",
+        # 替换为
+        rep: "",
+      },
+    ]
+
+# 账号配置列表
+accounts:
+  default:
+    # 机器人ID 必须为字符串
+    appId: "123456789"
+    # 机器人密钥
+    secret: "123456789"
+    # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
+    sendMode: 0
+    # 文本中的url转二维码白名单 配置后将不转换这些url为二维码 优先级高于全局配置
+    exclude: []
+    # 接受到消息后对文本进行表达式处理 优先级高于全局配置
+    regex: []

package/lib/core/api.d.ts

@@ -0,0 +1,167 @@
+import WebSocket from 'ws';
+import { LoggerLevel } from 'node-karin';
+import { AccountCfgType } from '../utils/index.js';
+import { IdType, FileType, PathType, V2ApiType, UploadMediaOptions, SendMessageOptions, UploadMediaResponse, SubEvent } from '../types/index.js';
+export interface SendMessageResponse {
+    /** 消息唯一ID */
+    id: string;
+    /** 发送时间 */
+    timestamp: number;
+}
+/**
+ * {key: xxx, values: xxx}，模版内变量与填充值的kv映射
+ */
+export type Params = Array<{
+    key: string;
+    values: string[];
+}>;
+export declare class QQBotApi {
+    #private;
+    /**
+     * 开发者的appId
+     */
+    appId: string;
+    /**
+     * Bot的昵称
+     */
+    nick: string;
+    /**
+     * wss地址
+     */
+    wssUrl: string;
+    /**
+     * wss连接
+     */
+    wss: WebSocket;
+    seq: number;
+    /**
+     * 心跳内容
+     */
+    heartbeat: {
+        op: 1;
+        d: null | number;
+        session_id: string;
+    };
+    /**
+     * 心跳生命周期 单位：毫秒
+     */
+    heartbeat_interval: number;
+    /**
+     * 请求头 用于鉴权
+     */
+    headers: {
+        [key: string]: string;
+    };
+    /**
+     * 基本请求接口
+     */
+    host: string;
+    constructor(config: AccountCfgType);
+    logger(level: LoggerLevel, ...args: any[]): void;
+    /**
+     * post请求
+     * @param url 请求地址
+     * @param options 请求参数
+     */
+    post(url: string, options: any): Promise<import("got").Response<string> | undefined>;
+    /**
+     * 获取调用凭证
+     * @param clientSecret 开发者的Secret
+     * @param isRefresh 是否是刷新凭证
+     */
+    getAccessToken(isRefresh?: boolean): Promise<{
+        /**
+         * 凭证有效时间，单位：秒 需要在倒计时50秒内刷新凭证
+         */
+        expires_in: string;
+        /**
+         * 调用凭证
+         */
+        access_token: string;
+    }>;
+    /**
+     * wss鉴权
+     * @param isAuth 是否鉴权
+     */
+    wssAuth(isAuth: boolean): Promise<void>;
+    /**
+     * 获取wss地址
+     */
+    getWssUrl(): Promise<void>;
+    /**
+     * 创建wss连接
+     */
+    createWss(isAuth?: boolean): void;
+    payload(payload: string): void;
+    /**
+     * 事件处理
+     */
+    intents(data: SubEvent): Promise<void>;
+    /**
+     * 发送消息
+     * @param openid 用户、群openid
+     * @param type 请求路径类型
+     * @param options 请求参数
+     */
+    sendMessage(openid: string, type: PathType, options: SendMessageOptions): Promise<SendMessageResponse>;
+    /**
+     * 构建发送文本消息请求参数
+     */
+    buildText(content: string, id?: string, seq?: number): SendMessageOptions;
+    /**
+     * 上传富媒体文件
+     * @param openid 用户、群openid
+     * @param type 请求类型
+     * @param file 文件内容 http、base64、file://
+     * @param file_type 文件类型
+     */
+    uploadMedia(openid: string, type: PathType, file: string, file_type: FileType): Promise<UploadMediaResponse>;
+    /**
+     * 构建v2接口请求地址
+     * @param openid 用户、群openid
+     * @param type 请求类型
+     * @param apiType v2接口类型
+     */
+    buildUrl(openid: string, type: PathType, apiType: V2ApiType): string;
+    /**
+     * 传入一个msg_id或者event_id 返回其对应的key和value
+     * @param id 消息id或者事件id
+     */
+    buildId(id: string): {
+        key: IdType;
+        value: string;
+    };
+    /**
+     * 构建发送富媒体请求参数
+     * 富媒体消息只能单独发送 并且必须进行上传
+     * @param file_info 富媒体接口返回的file_info
+     * @param id 消息id或者事件id
+     */
+    buildMedia(file_info: string, id?: string, seq?: number): SendMessageOptions;
+    /**
+     * 构建发送Markdown模板请求参数
+     * @param custom_template_id 模板id
+     * @param params 模板参数
+     * @param id 消息id或者事件id
+     * @param seq 消息序号
+     */
+    buildTplMarkdown(custom_template_id: string, params: Params, keyboard: SendMessageOptions['keyboard'], id?: string, seq?: number): SendMessageOptions;
+    /**
+     * 构建发送原生Markdown请求参数
+     * @param content markdown文本
+     * @param id 消息id或者事件id
+     * @param seq 消息序号
+     */
+    buildRawMarkdown(content: string, keyboard: SendMessageOptions['keyboard'], id?: string, seq?: number): SendMessageOptions;
+    /**
+     * 构建上传富媒体请求参数
+     * @param file 文件内容 http、base64、file://
+     * @param file_type 文件类型
+     */
+    buildUploadMedia(file: string, file_type: FileType): Promise<{
+        json: UploadMediaOptions;
+        headers: {
+            [key: string]: string;
+        };
+    }>;
+}